SnapCenter Software 4.8

HTML版のドキュメントが最新版です。 to English version

Swagger API WebページからREST APIにアクセスする方法

REST APIはSwagger Webページから利用できます。Swagger Webページにアクセスして、SnapCenter Server REST APIを表示したり、APIを手動で呼び出したりすることができます。REST APIを使用して、SnapCenter Serverの管理やデータ保護処理を行うことができます。

REST APIを実行するSnapCenter Serverの管理IPアドレスまたはドメイン名を確認しておく必要があります。

REST APIクライアントを実行するために特別な権限は必要ありません。すべてのユーザーがSwagger Webページにアクセスできます。REST APIでアクセスするオブジェクトに対する権限は、REST APIへのログインに使用するトークンを生成したユーザーに基づきます。

手順

  1. ブラウザーから、「https://<SnapCenter_IP_address_or_name>:<SnapCenter_port>/swagger/」の形式でURLを入力してSwagger Webページにアクセスします。

    REST APIのURLに、次の文字が含まれていないことを確認します:「+」、「.」、「%」、「&」
  2. Swagger APIドキュメントが自動的に表示されない場合は、Swaggerの[Explore]フィールドに、次のように入力します: https://<SnapCenter_IP_address_or_name>:<SnapCenter_port>/Content/swagger/SnapCenter.yaml

  3. [Explore]をクリックします。

    APIリソース タイプ(カテゴリー)の一覧が表示されます。

  4. APIリソース タイプをクリックすると、そのリソース タイプのAPIが表示されます。

SnapCenter REST APIの実行時に予期しない動作が発生した場合は、ログ ファイルで原因を特定して問題を解決することができます。 ログ ファイルは、SnapCenterのユーザー インターフェイスで[モニタ] > [ログ] > [ダウンロード]の順にクリックするとダウンロードできます。

Top of Page